#/
# @license Apache-2.0
#
# Copyright (c) 2018 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# VARIABLES #

# Define the command for linting license headers:
LICENSE_HEADER_LINT ?= $(TOOLS_PKGS_DIR)/lint/license-header-file-list/bin/cli

# Define the command flags:
LICENSE_HEADER_LINT_FLAGS ?=

# Define a `grep` regex filter to allow only certain file types to be lint:
license_header_filter := \(\.$(AWK_FILENAME_EXT)\|\.$(C_FILENAME_EXT)\|\.$(C_HEADER_FILENAME_EXT)\|\.$(CPP_FILENAME_EXT)\|\.$(CPP_HEADER_FILENAME_EXT)\|\.$(CSS_FILENAME_EXT)\|\.$(FORTRAN_FILENAME_EXT)\|\.$(GYP_FILENAME_EXT)\|\.$(GYPI_FILENAME_EXT)\|\.$(HTML_FILENAME_EXT)\|\.$(JAVASCRIPT_FILENAME_EXT)\|\.$(JULIA_FILENAME_EXT)\|\.$(MAKEFILE_FILENAME_EXT)\|\.$(MARKDOWN_FILENAME_EXT)\|\.$(PYTHON_FILENAME_EXT)\|\.$(R_FILENAME_EXT)\|\.$(SHELL_FILENAME_EXT)\|\.$(TYPESCRIPT_FILENAME_EXT)\|\.$(YAML_FILENAME_EXT)\|Makefile\)$$


# DEPENDENCIES #

# Note: keep in alphabetical order
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/c.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/cpp.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/fortran.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/javascript.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/julia.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/markdown.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/python.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/r.mk
include $(TOOLS_MAKE_LIB_DIR)/lint/license-headers/typescript.mk


# RULES #

#/
# Lints license headers.
#
# @example
# make lint-license-headers
#/
lint-license-headers: $(LICENSE_HEADER_LINT) $(NODE_MODULES)
	$(QUIET) $(FIND_FILES_CMD) | (grep "$(license_header_filter)" || test $$? = 1) | NODE_PATH="$(NODE_PATH)" $(NODE) $(LICENSE_HEADER_LINT) $(LICENSE_HEADER_LINT_FLAGS)

.PHONY: lint-license-headers

#/
# Lints license headers for a specified list of files.
#
# ## Notes
#
# -   This rule is useful when wanting to lint a list of files generated by some other command (e.g., a list of changed files obtained via `git diff`).
# -   The recipe uses a loop in order to avoid "argument list too long" errors.
#
#
# @param {string} FILES - list of file paths
#
# @example
# make lint-license-headers-files FILES='/foo/a.js /bar/b.js'
#/
lint-license-headers-files: $(LICENSE_HEADER_LINT) $(NODE_MODULES)
	$(QUIET) for file in $(FILES); do \
		echo $$file; \
	done | (grep "$(license_header_filter)" || test $$? = 1) | NODE_PATH="$(NODE_PATH)" $(NODE) $(LICENSE_HEADER_LINT) $(LICENSE_HEADER_LINT_FLAGS)

.PHONY: lint-license-headers-files
